﻿<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>WinMergeFS Documentation</title>
    </head>
<body>

        <h1>WinMergeFS Documentation</h1>
        <h2>Installation</h2>
        Download latest release, execute setup.exe or extract archive and install 
        DokanInstall32.msi from program folder.<br />
        <br />
        To install WinMergeFS as a system service run <pre>WinMergeFS.exe -install-service</pre>
        <h2>
            Usage</h2>
        <pre>Usage: WinMergeFS &lt;parameters&gt;

Parameters:
  -manual                             manual mount, expects -roots or -rroots and -driveletter
  -profile &lt;filename.xml&gt;             mount the specified profile

  -roots &lt;root1&gt;::&lt;root2&gt;::...        roots, separate by &quot;::&quot;
  -rroots &lt;root1&gt;::&lt;root2&gt;::...       like -roots, but read only
  -driveletter &lt;N&gt;                    drive letter to mount to
  -volumeid &lt;VolumeID&gt;                volume ID
  -plugins name,multiply,parameter    select plugins to load, separate by &quot;::&quot; uses &quot;diskspace,100,0&quot; if omitted

  -logfile none|console|&lt;filename&gt;    specify log file (default: console)
  -loglevel debug|info|error|none     select log verbosity (default: info)

  -sample &lt;filename&gt;                  create sample service configuration file
  -install-service                    install service on the system
  -remove-service                     remove the service from the system
  -debug-service                      run server config (config.xml) in console forces logfile=console, loglevel=debug

  -version                            show version information
</pre>
        <br />
        <h3>
            Example Usage</h3>
        <pre>WinMergeFS.exe -profile ExampleProfile.xml
      Mounts profile saved in ExampleProfile.xml.

WinMergeFS.exe -manual -driveletter n -volumeid WinMergeFS -roots C:\Folder1::C:\Folder2
      Mounts C:\Folder1 and C:\Folder2 into drive N:\ with volume id WinMergeFS.

WinMergeFS.exe -manual -driveletter n -volumeid WinMergeFS -roots C:\Folder1::C:\Folder2 -plugins diskspace,100,0 -logfile WinMergeFS.log -loglevel debug
      Mounts C:\Folder1 and C:\Folder2 into drive N:\ with volume id WinMergeFS,
      uses diskspace plugin with multiplier 100 and writes debug log to WinMergeFS.log
</pre>
        <br />
        <h2>
            Root Selection</h2>
        Root Selection is plugin based.<br />
        Each plugin calculates a rating between 0 and 1, multipliys it with the 
        multiplier and adds the result to a decision table.<br />
        The root with the most points is used to create new files and directorys.<br />
        <h3>
            Plugins</h3>
        <h4>
            force</h4>
        <b>Forces all new files and directorys to be written to a specified root.</b><br />
        <b>Parameter:</b> rootID of root to be used. First root has ID 0, second root 
        has ID 1 ...<br />
        Multiplier has no effect on this plugin. All other plugins are ignored.<br />
        <h4>
            diskspace</h4>
        <b>New files and directorys are written to the root with the most free available 
        diskspace.</b><br />
        <b>Parameter:</b> not used

</body>
</html>
